CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/roles (Get)
In This Topic
    Get/projects/{projectId}/roles
    In This Topic
    Description
    returns a list of roles in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    the id of the project to look instring
    number of records to skip for paginationinteger (int32)
    maximum number of records to returninteger (int32)
    provides a wild card string to filter roles by their RoleID.string
    200 Response

    The response body is of type RolesGetResponse.

    The collection of roles that satisfy the query.

    Overview

    RolesGetResponse
    The results of the roles get query.
    Roles : Array[CimRole]
    An array of the roles that satify the query criteria.
    Configuration : CimConfigurationPrivileges
    Contains the previliges related to configuration security
    Alarms : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Classes : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Clients : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    DatabaseLogging : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Devices : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    GlobalParameters : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Objects : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Points : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Ports : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Projects : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    RemoteProjects : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Resources : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Roles : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Users : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    WebConfigEnable : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Workbench : boolean
    set it to true to specify the type of configuration privileges available to users who are assigned to the role.
    Privileges : CimPrivileges
    Contains the previliges related to security
    ChangeApprovalVerify : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    DeleteAlarms : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    DisableOrModifyAlarms : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    DynamicConfiguration : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    ModifyAlarmSetups : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    ModifyAttributes : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    OPCUAServerAdmin : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    PointByAddress : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    PointTarget : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    ProcessControl : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    RightClickMenu : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    ScriptControl : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    SetPoint : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    SetpointAuditTrail : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    StartProject : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    StopProject : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    TriggerEvents : boolean
    set it to true to specify this privileges available to users who are assigned to the role.
    Level : integer
    is a number to indicate the level at which the role can set points.
    RoleID : string
    The Id of role.
    Fault Responses
    FaultDescription
    This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also